// Copyright (C) 2017 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package subject

import (
	"context"

	"github.com/google/gapid/test/robot/search"
)

// Handler is a function that handles a stream of Subjects.
type Handler func(context.Context, *Subject) error

// Subjects is the interface to a subject manager.
type Subjects interface {
	// Search returns a iterator of matching subjects from the store.
	Search(context.Context, *search.Query, Handler) error
	// Add adds a new subject to the set.
	Add(ctx context.Context, id string, obbID string, hints *Hints) (*Subject, bool, error)
	// Update changes the values of a subject.
	Update(ctx context.Context, subj *Subject) (*Subject, error)
}
